<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">

	<title>Class LeanCloud\GeoPoint</title>

	<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
				<h3>Namespaces</h3>
			<ul>
				<li class="active">
					<a href="namespace-LeanCloud.html">
						LeanCloud<span></span>
					</a>

						<ul>
				<li>
					<a href="namespace-LeanCloud.Engine.html">
						Engine					</a>

						</li>
				<li>
					<a href="namespace-LeanCloud.Operation.html">
						Operation					</a>

						</li>
				<li>
					<a href="namespace-LeanCloud.Storage.html">
						Storage					</a>

						</li>
				<li>
					<a href="namespace-LeanCloud.Uploader.html">
						Uploader					</a>

						</li>
							</ul></li>
			</ul>
		</div>

		<hr>


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-LeanCloud.ACL.html">ACL</a></li>
				<li><a href="class-LeanCloud.Bytes.html">Bytes</a></li>
				<li><a href="class-LeanCloud.Client.html">Client</a></li>
				<li><a href="class-LeanCloud.File.html">File</a></li>
				<li class="active"><a href="class-LeanCloud.GeoPoint.html">GeoPoint</a></li>
				<li><a href="class-LeanCloud.MIMEType.html">MIMEType</a></li>
				<li><a href="class-LeanCloud.Object.html">Object</a></li>
				<li><a href="class-LeanCloud.Push.html">Push</a></li>
				<li><a href="class-LeanCloud.Query.html">Query</a></li>
				<li><a href="class-LeanCloud.Relation.html">Relation</a></li>
				<li><a href="class-LeanCloud.Role.html">Role</a></li>
				<li><a href="class-LeanCloud.SaveOption.html">SaveOption</a></li>
				<li><a href="class-LeanCloud.SMS.html">SMS</a></li>
				<li><a href="class-LeanCloud.User.html">User</a></li>
			</ul>



			<h3>Exceptions</h3>
			<ul>
				<li><a href="class-LeanCloud.BatchRequestError.html">BatchRequestError</a></li>
				<li><a href="class-LeanCloud.CloudException.html">CloudException</a></li>
			</ul>


		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="">
		<input type="hidden" name="ie" value="UTF-8">
		<input type="text" name="q" class="text" placeholder="Search">
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="namespace-LeanCloud.html" title="Summary of LeanCloud"><span>Namespace</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class GeoPoint</h1>


	<div class="description">
	<p>GeoPoint type representation</p>

<p>It represents a geographic point, and supports computing geo
distance from point to point. It can also be used in Query to
build proximity-based queries.</p>
	</div>









	<div class="info">
		
		
		<b>Namespace:</b> <a href="namespace-LeanCloud.html">LeanCloud</a><br>
		

				<b>See:</b>
				<code><a href="class-LeanCloud.Query.html">LeanCloud\Query</a></code><br>
			<b>Located at</b> <a href="source-class-LeanCloud.GeoPoint.html#5-106" title="Go to source code">LeanCloud/GeoPoint.php</a>
		<br>
	</div>



	<table class="summary methods" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="__construct" id="___construct">

		<td class="attributes"><code>
			 public 

			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___construct">#</a>
		<code><a href="source-class-LeanCloud.GeoPoint.html#25-41" title="Go to source code">__construct</a>( <span>number <var>$latitude</var> = <span class="php-num">0.0</span></span>, <span>number <var>$longitude</var> = <span class="php-num">0.0</span></span> )</code>

		<div class="description short">
			<p>Initialize a geo point</p>
		</div>

		<div class="description detailed hidden">
			<p>Initialize a geo point</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$latitude</var></dt>
					<dd></dd>
					<dt><var>$longitude</var></dt>
					<dd></dd>
				</dl></div>


				<h4>Throws</h4>
				<div class="list">
					InvalidArgumentException
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="getLatitude" id="_getLatitude">

		<td class="attributes"><code>
			 public 

			number
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getLatitude">#</a>
		<code><a href="source-class-LeanCloud.GeoPoint.html#43-48" title="Go to source code">getLatitude</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			



				<h4>Returns</h4>
				<div class="list">
					number
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getLongitude" id="_getLongitude">

		<td class="attributes"><code>
			 public 

			number
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getLongitude">#</a>
		<code><a href="source-class-LeanCloud.GeoPoint.html#50-55" title="Go to source code">getLongitude</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			



				<h4>Returns</h4>
				<div class="list">
					number
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="radiansTo" id="_radiansTo">

		<td class="attributes"><code>
			 public 

			number
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_radiansTo">#</a>
		<code><a href="source-class-LeanCloud.GeoPoint.html#57-77" title="Go to source code">radiansTo</a>( <span><code><a href="class-LeanCloud.GeoPoint.html">LeanCloud\GeoPoint</a></code> <var>$point</var></span> )</code>

		<div class="description short">
			<p>Compute distance (in radians) to a geo point</p>
		</div>

		<div class="description detailed hidden">
			<p>Compute distance (in radians) to a geo point</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$point</var></dt>
					<dd>Other geo point</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					number
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="kilometersTo" id="_kilometersTo">

		<td class="attributes"><code>
			 public 

			number
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_kilometersTo">#</a>
		<code><a href="source-class-LeanCloud.GeoPoint.html#79-87" title="Go to source code">kilometersTo</a>( <span><code><a href="class-LeanCloud.GeoPoint.html">LeanCloud\GeoPoint</a></code> <var>$point</var></span> )</code>

		<div class="description short">
			<p>Compute distance (in kilometers) to other geo point</p>
		</div>

		<div class="description detailed hidden">
			<p>Compute distance (in kilometers) to other geo point</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$point</var></dt>
					<dd>Other geo point</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					number
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="milesTo" id="_milesTo">

		<td class="attributes"><code>
			 public 

			number
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_milesTo">#</a>
		<code><a href="source-class-LeanCloud.GeoPoint.html#89-97" title="Go to source code">milesTo</a>( <span><code><a href="class-LeanCloud.GeoPoint.html">LeanCloud\GeoPoint</a></code> <var>$point</var></span> )</code>

		<div class="description short">
			<p>Compute distance (in miles) to other geo point</p>
		</div>

		<div class="description detailed hidden">
			<p>Compute distance (in miles) to other geo point</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$point</var></dt>
					<dd>Other geo point</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					number
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="encode" id="_encode">

		<td class="attributes"><code>
			 public 

			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_encode">#</a>
		<code><a href="source-class-LeanCloud.GeoPoint.html#99-105" title="Go to source code">encode</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			







		</div>
		</div></td>
	</tr>
	</table>


















</div>

	<div id="footer">
		 API documentation generated by <a href="http://apigen.org">ApiGen</a>
	</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>
